Package-level declarations

Types

Link copied to clipboard
@Serializable
data class CategoryInfo(val categoryName: String, val categoryGroup: String)
Link copied to clipboard
@Serializable
data class GeoJsonGeometry(val type: String, val coordinates: List<Double>)
Link copied to clipboard
@Serializable
data class Geometry(val bbox: List<List<Double>>? = null, val geojson: GeoJsonGeometry? = null, val buffer: Int? = null)
Link copied to clipboard
@Serializable
data class PoiFeature(val type: String, val geometry: PoiGeometry, val properties: PoiProperties)

A single GeoJSON feature (Point)

Link copied to clipboard
@Serializable
data class PoiGeometry(val type: String, val coordinates: List<Double>)
Link copied to clipboard
@Serializable
data class PoiProperties(val osmId: Long, val osmType: Int, val distance: Double, val categoryIds: Map<Int, CategoryInfo>? = null, val osmTags: Map<String, String>? = null)

Properties seen in your sample. Some fields are optional across results.

Link copied to clipboard
@Serializable
data class PoisGeoJsonResponse(val type: String, val bbox: List<Double>? = null, val features: List<PoiFeature>, val information: PoisInformation? = null)

Top-level POIs GeoJSON response: { "type": "FeatureCollection", "bbox": minLon, minLat, maxLon, maxLat, "features": ..., "information": {...} }

Link copied to clipboard
@Serializable
data class PoisInformation(val attribution: String? = null, val version: String? = null, val timestamp: Long? = null, val query: PoisQueryInfo? = null)

The “information” block at the end of the response. Note: ORS uses "information" (not "metadata") here.

Link copied to clipboard
@Serializable
data class PoisQueryGeometry(val bbox: List<List<Double>>? = null, val geojson: GeoJsonGeometry? = null, val buffer: Int? = null)

Mirrors the request’s geometry wrapper

Link copied to clipboard
@Serializable
data class PoisQueryInfo(val request: String? = null, val geometry: PoisQueryGeometry? = null)

Echo of the request inside the information block

Link copied to clipboard
@Serializable
data class PoisRequest(val request: String = "pois", val geometry: Geometry, val filters: Map<String, String>? = null, val limit: Int? = null, val sortby: String? = null)

Request for the POIs endpoint.

Link copied to clipboard

Builder used by poisRequest.

Link copied to clipboard

Java-friendly builder counterpart.

Functions

Link copied to clipboard

DSL for constructing PoisRequest objects.